Skip to content

com.inscoper.api.DeviceConfig

DeviceConfig class provides information for device configuration. More...

Public Functions

Name
synchronized void delete()
DeviceConfig(EDriverType driverType)
Constructor.
void fromXML(XMLNode deviceNode)
Load from XML.
void toXML(XMLNode xmlParent)
Save to XML.
String getId()
Get the ID of the device.
void setId(String id)
Set the ID of the device.
EDriverType getDriverType()
Get the driver type of the device.
void setDriverType(EDriverType driverType)
Set the driver type of the device.
SubDeviceConfigVector getSubDeviceConfigList()
Get the sub-device configuration list.
void setSubDeviceConfigList(SubDeviceConfigVector subDevices)
Set the sub-device configuration list.
void addSubDeviceConfig(SubDeviceConfig subDevice)
Add a sub-device configuration to the list.
DriverConfig getDriverConfig()
Get the driver configuration.
void setDriverConfig(DriverConfig driverConfig)
Set the driver configuration.

Protected Functions

Name
DeviceConfig(long cPtr, boolean cMemoryOwn)
void swigSetCMemOwn(boolean own)
void finalize()
long getCPtr(DeviceConfig obj)

Detailed Description

public class com.inscoper.api.DeviceConfig;

DeviceConfig class provides information for device configuration.

This class holds the configuration parameters for a specific device, including its ID, driver type, sub-devices, and driver-specific settings.

Public Functions Documentation

function delete

public synchronized void delete()

function DeviceConfig

public DeviceConfig(
    EDriverType driverType
)

Constructor.

Parameters:

  • driverType : The driver type of the device

Initializes a new instance of DeviceConfig with the specified driver type.

function fromXML

public void fromXML(
    XMLNode deviceNode
)

Load from XML.

Parameters:

  • deviceNode : The XML node containing device information

Exceptions:

Populates the device configuration from the provided XML node.

function toXML

public void toXML(
    XMLNode xmlParent
)

Save to XML.

Parameters:

  • xmlParent : The parent XML node

Exceptions:

Serializes the device configuration to the specified parent XML node.

function getId

public String getId()

Get the ID of the device.

Return: The ID of the device

Retrieves the unique identifier of the device.

function setId

public void setId(
    String id
)

Set the ID of the device.

Parameters:

  • id : The ID of the device

Assigns a unique identifier to the device.

function getDriverType

public EDriverType getDriverType()

Get the driver type of the device.

Return: The driver type of the device

Retrieves the type of driver associated with this device.

function setDriverType

public void setDriverType(
    EDriverType driverType
)

Set the driver type of the device.

Parameters:

  • driverType : The driver type of the device

Sets the type of driver for this device.

function getSubDeviceConfigList

public SubDeviceConfigVector getSubDeviceConfigList()

Get the sub-device configuration list.

Return: The list of sub-device configurations

Retrieves the list of sub-device configurations associated with this device.

function setSubDeviceConfigList

public void setSubDeviceConfigList(
    SubDeviceConfigVector subDevices
)

Set the sub-device configuration list.

Parameters:

  • subDevices : The list of sub-device configurations

Replaces the current list of sub-device configurations.

function addSubDeviceConfig

public void addSubDeviceConfig(
    SubDeviceConfig subDevice
)

Add a sub-device configuration to the list.

Parameters:

  • subDevice : The sub-device configuration to add

Appends a new sub-device configuration to the device.

function getDriverConfig

public DriverConfig getDriverConfig()

Get the driver configuration.

Return: The driver configuration

Retrieves the specific configuration for the underlying driver.

function setDriverConfig

public void setDriverConfig(
    DriverConfig driverConfig
)

Set the driver configuration.

Parameters:

  • driverConfig : The driver configuration

Assigns the specific configuration for the underlying driver.

Protected Functions Documentation

function DeviceConfig

protected DeviceConfig(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn

protected void swigSetCMemOwn(
    boolean own
)

function finalize

protected void finalize()

function getCPtr

protected static long getCPtr(
    DeviceConfig obj
)

Updated on 2026-04-02 at 10:55:37 +0200